Clarify the docs ("darkened/brightened" is not "saturation").

2006-01-12  Federico Mena Quintero  <federico@ximian.com>

	* gdk-pixbuf-util.c (gdk_pixbuf_saturate_and_pixelate): Clarify
	the docs ("darkened/brightened" is not "saturation").

diff --git a/gdk-pixbuf/ChangeLog b/gdk-pixbuf/ChangeLog
index 7132110f9e866834a90c99c06622c27ee1461fc7..5573dc4757de16283cba2e3bad19e48c1e014128 100644 (file)
--- a/gdk-pixbuf/ChangeLog
+++ b/gdk-pixbuf/ChangeLog
@@ -1,3 +1,8 @@
+2006-01-12  Federico Mena Quintero  <federico@ximian.com>
+
+       * gdk-pixbuf-util.c (gdk_pixbuf_saturate_and_pixelate): Clarify
+       the docs ("darkened/brightened" is not "saturation").
+
 Fri Dec 30 00:59:21 2005  Jonathan Blandford  <jrb@redhat.com>
 
        * gdk-pixbuf-io.c (gdk_pixbuf_format_get_license): minor doc edit.

diff --git a/gdk-pixbuf/gdk-pixbuf-util.c b/gdk-pixbuf/gdk-pixbuf-util.c
index e6fa6f4df91f9678760e7a3361432bfe751e5dc7..c25576546cffe57382fb4281bfbe01b8f8879939 100644 (file)
--- a/gdk-pixbuf/gdk-pixbuf-util.c
+++ b/gdk-pixbuf/gdk-pixbuf-util.c
@@ -159,14 +159,14 @@ gdk_pixbuf_copy_area (const GdkPixbuf *src_pixbuf,
  * @saturation: saturation factor
  * @pixelate: whether to pixelate
  *
- * Modifies saturation and optionally pixelates @src, placing the
- * result in @dest. @src and @dest may be the same pixbuf with no ill
- * effects.  If @saturation is 1.0 then saturation is not changed. If
- * it's less than 1.0, saturation is reduced (the image is darkened);
- * if greater than 1.0, saturation is increased (the image is
- * brightened). If @pixelate is %TRUE, then pixels are faded in a
- * checkerboard pattern to create a pixelated image. @src and @dest
- * must have the same image format, size, and rowstride.
+ * Modifies saturation and optionally pixelates @src, placing the result in
+ * @dest. @src and @dest may be the same pixbuf with no ill effects.  If
+ * @saturation is 1.0 then saturation is not changed. If it's less than 1.0,
+ * saturation is reduced (the image turns toward grayscale); if greater than
+ * 1.0, saturation is increased (the image gets more vivid colors). If @pixelate
+ * is %TRUE, then pixels are faded in a checkerboard pattern to create a
+ * pixelated image. @src and @dest must have the same image format, size, and
+ * rowstride.
  * 
  **/
 void